Skip to main content

modify Device​

Modify device under a registry

Path Parameters
    subscriptionId string required

    Subscription ID

    registryId string required

    Registry ID

    deviceId string required

    Device ID

Query Parameters
    updateMask string required

    Possible values: [logLevel, blocked, metadata, credentials, gatewayConfig.gatewayAuthMethod, policy]

    Required. Only updates the device fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: credentials,logLevel, blocked,policy and metadata

Request Body required

application/json

    id string required

    Possible values: >= 3 characters and <= 256 characters

    blocked boolean
    credentials object[]
    expirationTime string
    publicKey object
    format string required

    Possible values: [RSA_PEM, ES256_PEM, RSA_X509_PEM, ES256_X509_PEM]

    key string
    gateway string[]
    gatewayConfig object
    gatewayAuthMethod string

    Possible values: [GATEWAY_AUTH_METHOD_UNSPECIFIED, ASSOCIATION_ONLY, DEVICE_AUTH_TOKEN_ONLY, ASSOCIATION_AND_DEVICE_AUTH_TOKEN]

    gatewayType string

    Possible values: [NON_GATEWAY, GATEWAY]

    lastErrorStatus object
    logLevel string

    Possible values: [INFO, ERROR]

    metadata object
  • property name* string
    • config object
    binaryData string
    version integer
    state object
    binaryData string
    updateTime string
    policy object
    Connect boolean required
    PublishState boolean required
    PublishEvents boolean required
    PublishEventsRegex string required
    PublishLoopback boolean required
    SubscribeCommand boolean required
    SubscribeCommandRegex string required
    SubscribeBroadcast boolean required
    SubscribeBroadcastRegex string required
    SubscribeConfig boolean required
    tcpUdpModelDetails object
    modelName string
    manufacturer string
    image object
    valid boolean required
    contentType string
    storageKey string
    data binary
    tcpDetails object
    enabled boolean required
    port uint32
    udpDetails object
    enabled boolean required
    port uint32
    metadata object
    tcpUdpModelId number
    isTcpUdpDevice boolean
Responses

OK

Schema
    id string

    Possible values: >= 3 characters and <= 256 characters

    name string
    numId string
    parent string
    registry string
    blocked boolean
    capresent boolean
    subscription string
    createdOn string
    updatedOn string
    credentials object[]
    expirationTime string
    id string
    publicKey object
    format string

    Possible values: [RSA_PEM, ES256_PEM, RSA_X509_PEM, ES256_X509_PEM]

    key string
    gateway string[]
    gatewayConfig object
    gatewayAuthMethod string

    Possible values: [GATEWAY_AUTH_METHOD_UNSPECIFIED, ASSOCIATION_ONLY, DEVICE_AUTH_TOKEN_ONLY, ASSOCIATION_AND_DEVICE_AUTH_TOKEN]

    gatewayType string

    Possible values: [NON_GATEWAY, GATEWAY]

    isGateway boolean
    deviceErrors string
    clientOnline boolean
    lastConfigAckTime string
    lastConfigSendTime string
    lastErrorStatus object
    code integer
    details string
    message string
    lastErrorTime string
    lastEventTime string
    lastHeartbeatTime string
    lastStateTime string
    logLevel string

    Possible values: [INFO, ERROR]

    metadata object
  • property name* string
    • config object
    acknowledged boolean
    binaryData string
    cloudUpdateTime string
    deviceAckTime string
    version integer
    state object
    binaryData string
    updateTime string
    policy object
    Connect boolean
    PublishState boolean
    PublishEvents boolean
    PublishEventsRegex string
    PublishLoopback boolean
    SubscribeCommand boolean
    SubscribeCommandRegex string
    SubscribeBroadcast boolean
    SubscribeBroadcastRegex string
    SubscribeConfig boolean
    tcpUdpModelDetails object
    id uint32
    modelName string
    manufacturer string
    image object
    valid boolean
    contentType string
    storageKey string
    link string
    data binary
    tcpDetails object
    enabled boolean
    port uint32
    udpDetails object
    enabled boolean
    port uint32
    metadata object
    createdAt date-time
    updatedAt date-time
    tcpUdpModelId number
    isTcpUdpDevice boolean
Loading...